<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Plurious Framework » \framework\Front</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Plurious Framework</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/framework.html"><i class="icon-th"></i> framework</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a href="../namespaces/plurious.html"><i class="icon-th"></i> plurious</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">439</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">82</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__clone" title="__clone :: Cannot clone a singleton"><span class="description">Cannot clone a singleton</span><pre>__clone()</pre></a></li>
<li class="method public inherited"><a href="#get" title="get :: Return a value that corresponds to the given key"><span class="description">Return a value that corresponds to the given key</span><pre>get()</pre></a></li>
<li class="method public inherited"><a href="#getElement" title="getElement :: Retrieves a single element (which may contain an array) from a registered array"><span class="description">Retrieves a single element (which may contain an array) from a registered array</span><pre>getElement()</pre></a></li>
<li class="method public "><a href="#getInstance" title="getInstance :: Retrieve instance of singleton"><span class="description">Retrieve instance of singleton</span><pre>getInstance()</pre></a></li>
<li class="method public inherited"><a href="#has" title="has :: Check for a value in the registry that corresponds to the given key"><span class="description">Check for a value in the registry that corresponds to the given key</span><pre>has()</pre></a></li>
<li class="method public inherited"><a href="#loadBase" title="loadBase :: Loads all the classes from the baseClass array provided by Front"><span class="description">Loads all the classes from the baseClass array provided by Front</span><pre>loadBase()</pre></a></li>
<li class="method public inherited"><a href="#loadClass" title="loadClass :: "><span class="description">loadClass()
        </span><pre>loadClass()</pre></a></li>
<li class="method public inherited"><a href="#set" title="set :: Store the key/value pair in the registry"><span class="description">Store the key/value pair in the registry</span><pre>set()</pre></a></li>
<li class="method public inherited"><a href="#setElement" title="setElement :: Appends an element to a registered array"><span class="description">Appends an element to a registered array</span><pre>setElement()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private "><a href="#__construct" title="__construct :: Private constructor used at initialization only"><span class="description">Private constructor used at initialization only</span><pre>__construct()</pre></a></li>
<li class="method private "><a href="#init" title="init :: Invoked only at initial launch - starts the entire process"><span class="description">Invoked only at initial launch - starts the entire process</span><pre>init()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected "><a href="#%24baseClasses" title="$baseClasses :: Holds the core classes required at launch"><span class="description">Holds the core classes required at launch</span><pre>$baseClasses</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="property private inherited"><a href="#%24data" title="$data :: The registry store"><span class="description">The registry store</span><pre>$data</pre></a></li>
<li class="property private "><a href="#%24instance" title="$instance :: Contains singleton instance"><span class="description">Contains singleton instance</span><pre>$instance</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cframework%5CFront" id="\framework\Front"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/framework.html">framework</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/framework.Front.html">Front</a>
</li>
</ul>
<div href="../classes/framework.Front.html" class="element class">
<p class="short_description">Plurious Framework Front Controller</p>
<div class="details">
<p class="long_description"><p>Extends Registry.</p>

<p>'IS A' registry for the entire framework</p>

<p>Singleton: use framework\Front::getInstance();</p></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:randy@plurious.com">Randy Casburn</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright Plurious Software, all rights reserved</td>
</tr>
<tr>
<th>license</th>
<td><a href="http://opensource.org/licenses/MIT">MIT</a></td>
</tr>
<tr>
<th>license</th>
<td><a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></td>
</tr>
<tr>
<th>link</th>
<td><a href="http://plurious.com/framework/documentation/classes/Front.html">http://plurious.com/framework/documentation/classes/Front.html</a></td>
</tr>
<tr>
<th>version</th>
<td>2.1</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\Registry</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\Config</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\engine\Action</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\Document</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\Request</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\Cache</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\access_control\User</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\library\Session</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\helper\Url</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\model\User_Admin_Model</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Actions</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\access_control\Role</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\access_control\User</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\authentication\Auth</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\Document</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\Document::renderFinal()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\Language</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\library\Loader</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__clone" id="__clone"></a><div class="element clickable method public __clone" data-toggle="collapse" data-target=".__clone .collapse">
<h2>Cannot clone a singleton</h2>
<pre>__clone() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="get" id="get"></a><div class="element clickable method public get" data-toggle="collapse" data-target=".get .collapse">
<h2>Return a value that corresponds to the given key</h2>
<pre>get(string $key) : mixed</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\library\Registry::get()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code><p>the value corresponding to this key will be returned</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>value corresponding the provided key</div>
</div></div>
</div>
<a name="getElement" id="getElement"></a><div class="element clickable method public getElement" data-toggle="collapse" data-target=".getElement .collapse">
<h2>Retrieves a single element (which may contain an array) from a registered array</h2>
<pre>getElement(array $array, string $key) : mixed</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\library\Registry::getElement()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$array</h4>
<code>array</code><p>The array to retrieve the element (key) from</p>
</div>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code><p>The key of the associated array element</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>The data associated with the key or null if $array is not an array</div>
</div></div>
</div>
<a name="getInstance" id="getInstance"></a><div class="element clickable method public getInstance" data-toggle="collapse" data-target=".getInstance .collapse">
<h2>Retrieve instance of singleton</h2>
<pre>getInstance() : Object</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Returns</h3>
<div class="subelement response">
<code>Object</code>Instance of Front</div>
</div></div>
</div>
<a name="has" id="has"></a><div class="element clickable method public has" data-toggle="collapse" data-target=".has .collapse">
<h2>Check for a value in the registry that corresponds to the given key</h2>
<pre>has(string $key) : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\library\Registry::has()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code><p>to search for</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>True if value exists for the given key</div>
</div></div>
</div>
<a name="loadBase" id="loadBase"></a><div class="element clickable method public loadBase" data-toggle="collapse" data-target=".loadBase .collapse">
<h2>Loads all the classes from the baseClass array provided by Front</h2>
<pre>loadBase(array $classes) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\framework\library\Loader::loadBase()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\library\Registry::loadBase()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$classes</h4>
<code></code>
</div>
</div></div>
</div>
<a name="loadClass" id="loadClass"></a><div class="element clickable method public loadClass" data-toggle="collapse" data-target=".loadClass .collapse">
<h2>loadClass()
        </h2>
<pre>loadClass(string $class, boolean $return) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\framework\library\Loader::loadClass()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\library\Registry::loadClass()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$class</h4>
<code>string</code><p>The full qualified namespaced name of the class to instantiate</p></div>
<div class="subelement argument">
<h4>$return</h4>
<code>boolean</code><p>True to return the class name False returns nothing</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>The class name</div>
</div></div>
</div>
<a name="set" id="set"></a><div class="element clickable method public set" data-toggle="collapse" data-target=".set .collapse">
<h2>Store the key/value pair in the registry</h2>
<pre>set(string $key, mixed $value) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\library\Registry::set()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code>
</div>
</div></div>
</div>
<a name="setElement" id="setElement"></a><div class="element clickable method public setElement" data-toggle="collapse" data-target=".setElement .collapse">
<h2>Appends an element to a registered array</h2>
<pre>setElement(string $array_name, mixed $data, string $keyname) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\library\Registry::setElement()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$array_name</h4>
<code>string</code><p>Name of registry key containing array to append data to</p></div>
<div class="subelement argument">
<h4>$data</h4>
<code>mixed</code><p>the data to append to $array_name</p>
</div>
<div class="subelement argument">
<h4>$keyname</h4>
<code>string</code><p>The key to associate with the appended value</p></div>
</div></div>
</div>
<a name="__construct" id="__construct"></a><div class="element clickable method private __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Private constructor used at initialization only</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="init" id="init"></a><div class="element clickable method private init" data-toggle="collapse" data-target=".init .collapse">
<h2>Invoked only at initial launch - starts the entire process</h2>
<pre>init() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Uses the route obtained from the $_GET superglobal.  Route must be in
the form [context/]controller[/method/arg/arg/...] where brackets
surround optional portions.</p></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\Actions</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\Request</td>
</tr>
</table>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24baseClasses" id="$baseClasses"> </a><div class="element clickable property protected $baseClasses" data-toggle="collapse" data-target=".$baseClasses .collapse">
<h2>Holds the core classes required at launch</h2>
<pre>$baseClasses : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24data" id="$data"> </a><div class="element clickable property private $data" data-toggle="collapse" data-target=".$data .collapse">
<h2>The registry store</h2>
<pre>$data </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\library\Registry::$$data</td>
</tr></table>
</div></div>
</div>
<a name="%24instance" id="$instance"> </a><div class="element clickable property private $instance" data-toggle="collapse" data-target=".$instance .collapse">
<h2>Contains singleton instance</h2>
<pre>$instance : object</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a7</a> and<br>
            generated on 2012-07-06T18:53:43-05:00.<br></footer></div>
</div>
</body>
</html>
